The Option Definition Page

Use the Option Definition page to create and manage the options for the reports in your Reserves instance.

This page is primarily for use by Reserves administrators. Changing settings on this page can prevent your reports from functioning properly.
  1. Select Report Management from the Navigation Toolbar.
  2. Click on the Reports tab, and then the Option Definition page.

Create a new Report Option

To create a new report option, follow these steps:

  1. Select the context in which you want to create a new report option using the Context drop-down menu.
  2. Click the Create button.
  3. Enter a name for your report option in the Report Option field.
    4. Option names must be unique and cannot contain spaces.
  4. Select a control type using the Control Type drop-down menu.

    5. Click image to expand or minimize.

  5. Certain control types include options that will need to be configured. If necessary, set up the control's options at this time.
  6. Enter a display name for your option in the Report Option field. This will be the name that appears on The Report Options Page.
  7. (Optional) Enter comments associated with your option in the Comment field.
  8. Click the Save button to save your option.

Create Tooltip Comments

You may wish to add tooltip comments to your report options. Typically, tooltip comments are used to store brief descriptions of your report options. To set up a tooltip comment, follow these steps:

  1. After accessing the Option Definition page, select a context using the Context drop-down menu.
    2. Remember that report options are context-sensitive — as such, adding a comment to a report option in the Economics context will not affect a report option with the same name in the Reconciliation context. For report options that exist in multiple contexts (Units, Subtotalling, Show all Hierarchy Attributes... etc), adding a tooltip comment in one context will not affect the same option in another context.
  2. If you are making changes to a preexisting report option, select the option you intend to modify using the Report Option drop-down menu and then click the Edit button. If you are creating a new report option, click the Create button.
  3. While creating or editing a report option, locate the Comment field below the Option Setup pane.
  4. Enter your tooltip comment in the Comments field.

    5. Click image to expand or minimize.

  5. Click the Save button to save your report option.

Now, when users access The Report Options Page, they can view the comment by hovering over the tooltip icon wherever the report option is used.

Create Comment Report Options

You can create comment report options using this page. These comments are placeholders for report options, and won't include any usable functionality. Instead, they are used to display blocks of text within your report options. Once you've created a comment report option, you will need to assign it to your reports using The Report Manager Page. To create a comment report option, follow these steps:

  1. After accessing the Option Definition page, select the context for your report option control using the Context drop-down menu. Remember that report options are context sensitive.
  2. Click the Create button.
  3. Enter a name for your report option in the Report Option field. Option names must start with a letter or underscore, and cannot include spaces.
  4. Select Comment using the Control Type drop-down menu.
  5. Enter a label for your for your comment option in the Label field. The name you enter here will be used as a display name for your option on The Report Options Page.
  6. Add the text you want to display on The Report Options Page to the Comment field.

    7. Click image to expand or minimize. 

    You can style these comments using HTML. See Styling Comment Report Options later on this page for more information.
  7. (Optional) Add a tooltip comment to your comment option using the Comment field below the Option Setup pane.
  8. Click the Save button to save your comment loader option.

Once you have finished setting up your comment option, assign it to your reports using The Report Manager Page.

Styling Comment Report Options

You can style and format comment report options using HTML. In the example below, an example styled comment is displayed.

Click image to expand or minimize.

Edit a Report Option

To make changes to a report option, follow these steps:

  1. Select the context associated with the option you wish to modify using the Context drop-down menu.
  2. Select the option you wish to modify using the Report Options drop-down menu.
    3. When you select a report option, all of the reports it is linked to will be displayed near the bottom of the screen.
  3. Click the Edit button.
  4. Modify your control's options as necessary.
  5. Click the Save button to save your changes.

Delete a Report Option

To delete a report option, follow these steps:

  1. Select the context associated with the option you wish to delete using the Context drop-down menu.
  2. Select the option you wish to delete using the Report Options drop-down menu.
  3. Click the Delete button.
    4. You will not be able to delete report options that are linked to reports.
  4. You will be prompted to confirm the deletion. Click OK to delete your report option.

Adding Options to Reports

After you create report options, link them to reports using The Report Manager Page.

Viewing Report Comments

Once comments have been added to your reports, you can view the comments on The Report Options Page.